/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.net.pop3;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import java.net.InetAddress;
import java.io.IOException;
import java.io.Reader;
/**
* @author <a href="mailto:commons-dev@apache.org">[Net]</a>
* @version $Id: POP3ClientCommandsTest.java 631313 2008-02-26 17:41:09Z niallp $
*
* The POP3* tests all presume the existence of the following parameters:
* mailserver: localhost (running on the default port 110)
* account: username=test; password=password
* account: username=alwaysempty; password=password.
* mail: At least four emails in the test account and zero emails
* in the alwaysempty account
*
* If this won't work for you, you can change these parameters in the
* TestSetupParameters class.
*
* The tests were originally run on a default installation of James.
* Your mileage may vary based on the POP3 server you run the tests against.
* Some servers are more standards-compliant than others.
*/
public class POP3ClientCommandsTest extends TestCase
{
POP3Client p = null;
String user = TestSetupParameters.user;
String emptyUser = TestSetupParameters.emptyuser;
String password = TestSetupParameters.password;
String mailhost = TestSetupParameters.mailhost;
/**
*
*/
public POP3ClientCommandsTest(String name)
{
super(name);
}
/**
* Method suite.
* @return TestSuite
*/
public static TestSuite suite()
{
return (new TestSuite(POP3ClientCommandsTest.class));
}
private void reset() throws IOException
{
//Case where this is the first time reset is called
if (p == null)
{
//Do nothing
}
else if (p.isConnected())
{
p.disconnect();
}
p = null;
p = new POP3Client();
}
private void connect() throws Exception
{
p.connect(InetAddress.getByName(mailhost));
assertTrue(p.isConnected());
assertEquals(POP3.AUTHORIZATION_STATE, p.getState());
}
private void login() throws Exception
{
assertTrue(p.login(user, password));
assertEquals(POP3.TRANSACTION_STATE, p.getState());
}
/**
*
*
*/
public void testNoopCommand() throws Exception
{
reset();
connect();
//Should fail before authorization
assertFalse(p.noop());
//Should pass in transaction state
login();
assertTrue(p.noop());
//Should fail in update state
p.setState(POP3.UPDATE_STATE);
assertFalse(p.noop());
}
/**
*
*
*/
public void testStatus() throws Exception
{
reset();
connect();
//Should fail in authorization state
assertNull(p.status());
//Should pass on a mailbox with mail in it
login();
POP3MessageInfo msg = p.status();
assertTrue(msg.number > 0);
assertTrue(msg.size > 0);
assertNull(msg.identifier);
p.logout();
//Should also pass on a mailbox with no mail in it
reset();
connect();
assertTrue(p.login(emptyUser, password));
POP3MessageInfo msg2 = p.status();
assertTrue(msg2.number == 0);
assertTrue(msg2.size == 0);
assertNull(msg2.identifier);
p.logout();
//Should fail in the 'update' state
reset();
connect();
login();
p.setState(POP3.UPDATE_STATE);
assertNull(p.status());
}
/**
*
*
*/
public void testListMessagesOnFullMailbox() throws Exception
{
reset();
connect();
login();
POP3MessageInfo[] msg = p.listMessages();
assertTrue(msg.length > 0);
for(int i = 0; i < msg.length; i++)
{
assertNotNull(msg[i]);
assertTrue(msg[i].number == i + 1);
assertTrue(msg[i].size > 0);
assertNull(msg[i].identifier);
}
//Now test from the update state
p.setState(POP3.UPDATE_STATE);
msg = p.listMessages();
assertNull(msg);
}
/**
*
*
*/
public void testListMessageOnFullMailbox() throws Exception
{
reset();
connect();
login();
//The first message is always at index 1
POP3MessageInfo msg = p.listMessage(1);
assertNotNull(msg);
assertTrue(msg.number == 1);
assertTrue(msg.size > 0);
assertNull(msg.identifier);
//Now retrieve a message from index 0
msg = p.listMessage(0);
assertNull(msg);
//Now retrieve a msg that is not there
msg = p.listMessage(100000);
assertNull(msg);
//Now retrieve a msg with a negative index
msg = p.listMessage(-2);
assertNull(msg);
//Now try to get a valid message from the update state
p.setState(POP3.UPDATE_STATE);
msg = p.listMessage(1);
assertNull(msg);
}
/**
*
*
*/
public void testListMessagesOnEmptyMailbox() throws Exception
{
reset();
connect();
assertTrue(p.login(emptyUser, password));
POP3MessageInfo[] msg = p.listMessages();
assertTrue(msg.length == 0);
//Now test from the update state
p.setState(POP3.UPDATE_STATE);
msg = p.listMessages();
assertNull(msg);
}
/**
*
*
*/
public void testListMessageOnEmptyMailbox() throws Exception
{
reset();
connect();
assertTrue(p.login(emptyUser, password));
//The first message is always at index 1
POP3MessageInfo msg = p.listMessage(1);
assertNull(msg);
}
/**
*
*
*/
public void testListUniqueIDsOnFullMailbox() throws Exception
{
reset();
connect();
login();
POP3MessageInfo[] msg = p.listUniqueIdentifiers();
assertTrue(msg.length > 0);
for(int i = 0; i < msg.length; i++)
{
assertNotNull(msg[i]);
assertTrue(msg[i].number == i + 1);
assertNotNull(msg[i].identifier);
}
//Now test from the update state
p.setState(POP3.UPDATE_STATE);
msg = p.listUniqueIdentifiers();
assertNull(msg);
}
/**
*
*
*/
public void testListUniqueIDOnFullMailbox() throws Exception
{
reset();
connect();
login();
//The first message is always at index 1
POP3MessageInfo msg = p.listUniqueIdentifier(1);
assertNotNull(msg);
assertTrue(msg.number == 1);
assertNotNull(msg.identifier);
//Now retrieve a message from index 0
msg = p.listUniqueIdentifier(0);
assertNull(msg);
//Now retrieve a msg that is not there
msg = p.listUniqueIdentifier(100000);
assertNull(msg);
//Now retrieve a msg with a negative index
msg = p.listUniqueIdentifier(-2);
assertNull(msg);
//Now try to get a valid message from the update state
p.setState(POP3.UPDATE_STATE);
msg = p.listUniqueIdentifier(1);
assertNull(msg);
}
/**
*
*
*/
public void testListUniqueIDsOnEmptyMailbox() throws Exception
{
reset();
connect();
assertTrue(p.login(emptyUser, password));
POP3MessageInfo[] msg = p.listUniqueIdentifiers();
assertTrue(msg.length == 0);
//Now test from the update state
p.setState(POP3.UPDATE_STATE);
msg = p.listUniqueIdentifiers();
assertNull(msg);
}
/**
*
*
*/
public void testListUniqueIdentifierOnEmptyMailbox() throws Exception
{
reset();
connect();
assertTrue(p.login(emptyUser, password));
//The first message is always at index 1
POP3MessageInfo msg = p.listUniqueIdentifier(1);
assertNull(msg);
}
/**
*
*
*/
public void testRetrieveMessageOnFullMailbox() throws Exception
{
reset();
connect();
login();
int reportedSize = 0;
int actualSize = 0;
POP3MessageInfo[] msg = p.listMessages();
assertTrue(msg.length > 0);
for (int i = msg.length; i > 0; i--)
{
reportedSize = msg[i - 1].size;
Reader r = p.retrieveMessage(i);
assertNotNull(r);
int delaycount = 0;
if (!r.ready())
{
//Give the reader time to get the message
//from the server
Thread.sleep(500);
delaycount++;
//but don't wait too long
if (delaycount == 4)
{
break;
}
}
while(r.ready())
{
r.read();
actualSize++;
}
//Due to variations in line termination
//on different platforms, the actual
//size may vary slightly. On Win2KPro, the
//actual size is 2 bytes larger than the reported
//size.
assertTrue(actualSize >= reportedSize);
}
}
/**
*
*
*/
public void testRetrieveMessageOnEmptyMailbox() throws Exception
{
reset();
connect();
assertTrue(p.login(emptyUser, password));
assertNull(p.retrieveMessage(1));
}
/**
*
*
*/
public void testRetrieveMessageShouldFails() throws Exception
{
reset();
connect();
login();
//Try to get message 0
assertNull(p.retrieveMessage(0));
//Try to get a negative message
assertNull(p.retrieveMessage(-2));
//Try to get a message that is not there
assertNull(p.retrieveMessage(100000));
//Change states and try to get a valid message
p.setState(POP3.UPDATE_STATE);
assertNull(p.retrieveMessage(1));
}
/**
*
*
*/
public void testRetrieveMessageTopOnFullMailbox() throws Exception
{
reset();
connect();
login();
int numLines = 10;
POP3MessageInfo[] msg = p.listMessages();
assertTrue(msg.length > 0);
for (int i = 0; i < msg.length; i++)
{
Reader r = p.retrieveMessageTop(i + 1, numLines);
assertNotNull(r);
r.close();
r = null;
}
}
/**
*
*
*/
public void testRetrieveOverSizedMessageTopOnFullMailbox() throws Exception
{
reset();
connect();
login();
int reportedSize = 0;
int actualSize = 0;
POP3MessageInfo msg = p.listMessage(1);
reportedSize = msg.size;
//Now try to retrieve more lines than exist in the message
Reader r = p.retrieveMessageTop(1, 100000);
assertNotNull(r);
int delaycount = 0;
while(!r.ready())
{
//Give the reader time to get the message
//from the server
Thread.sleep(500);
delaycount++;
//but don't wait too long
if (delaycount == 4)
{
break;
}
}
while(r.ready())
{
r.read();
actualSize++;
}
//Due to variations in line termination
//on different platforms, the actual
//size may vary slightly. On Win2KPro, the
//actual size is 2 bytes larger than the reported
//size.
assertTrue(actualSize >= reportedSize);
}
/**
*
*
*/
public void testRetrieveMessageTopOnEmptyMailbox() throws Exception
{
reset();
connect();
assertTrue(p.login(emptyUser, password));
assertNull(p.retrieveMessageTop(1, 10));
}
/**
*
*
*/
public void testRetrieveMessageTopShouldFails() throws Exception
{
reset();
connect();
login();
//Try to get message 0
assertNull(p.retrieveMessageTop(0, 10));
//Try to get a negative message
assertNull(p.retrieveMessageTop(-2, 10));
//Try to get a message that is not there
assertNull(p.retrieveMessageTop(100000, 10));
//Change states and try to get a valid message
p.setState(POP3.UPDATE_STATE);
assertNull(p.retrieveMessageTop(1, 10));
}
public void testDeleteWithReset() throws Exception
{
reset();
connect();
login();
//Get the original number of messages
POP3MessageInfo[] msg = p.listMessages();
int numMessages = msg.length;
int numDeleted = 0;
//Now delete some and logout
for (int i = 0; i < numMessages - 1; i ++)
{
p.deleteMessage(i + 1);
numDeleted++;
}
//Check to see that they are marked as deleted
assertEquals(numMessages, (numDeleted + 1));
//Now reset to unmark the messages as deleted
p.reset();
//Logout and come back in
p.logout();
reset();
connect();
login();
//Get the new number of messages, because of
//reset, new number should match old number
msg = p.listMessages();
assertEquals(numMessages, msg.length);
}
public void testDelete() throws Exception
{
reset();
connect();
login();
//Get the original number of messages
POP3MessageInfo[] msg = p.listMessages();
int numMessages = msg.length;
int numDeleted = 0;
//Now delete some and logout
for (int i = 0; i < numMessages - 3; i ++)
{
p.deleteMessage(i + 1);
numDeleted++;
}
//Check to see that they are marked as deleted
assertEquals(numMessages, (numDeleted + 3));
//Logout and come back in
p.logout();
reset();
connect();
login();
//Get the new number of messages, because of
//reset, new number should match old number
msg = p.listMessages();
assertEquals(numMessages - numDeleted, msg.length);
}
public void testResetAndDeleteShouldFails() throws Exception
{
reset();
connect();
login();
p.setState(POP3.UPDATE_STATE);
assertFalse(p.reset());
assertFalse(p.deleteMessage(1));
}
}